Skip to content

Add nginxGateway.name usage in case of its presence instead of nameOverride #3527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Add nginxGateway.name usage in case of its presence instead of nameOverride #3527

wants to merge 2 commits into from

Conversation

@tataruty
Copy link
Contributor

Add nginxGateway.name usage in case of its presence instead of nameOverride

Proposed changes

As a user of NGF's Helm Charts
I want to use a nginxGateway.name to configure the names of my deployments
So that I don't have to use nameOverride to override the entire name.

Testing:

name = momo, nameOverride = overrrmi, releaseName = chart,  chart.name = nginx-gateway-fabric
result: chart-momo
proxy: momo-proxy-config
config: momo-config


name = chart, nameOverride = overrrmi, releaseName = chart, chart.name = nginx-gateway-fabric
result: chart
proxy: chart-proxy-config
config: chart-config


name =  , nameOverride = chart, releaseName = chart, chart.name = nginx-gateway-fabric
result: chart
proxy: chart-proxy-config
config: chart-config

name = momo, nameOverride = , releaseName = chart, chart.name = nginx-gateway-fabric
result: chart-momo
proxy: momo-proxy-config
config: momo-config

name = , nameOverride = overrrmi, releaseName = chart, chart.name = nginx-gateway-fabric
result: chart-overrrmi
proxy: overrrmi-proxy-config
config: overrrmi-config

name = , nameOverride = , releaseName = chart, chart.name = nginx-gateway-fabric
result: chart-nginx-gateway-fabric
proxy: chart-proxy-config
config: chart-config


name = , nameOverride = , releaseName = nginx-gateway-fabric, chart.name = nginx-gateway-fabric
result: nginx-gateway-fabric
proxy: nginx-gateway-fabric-proxy-config
config: nginx-gateway-fabric-config

 name = , nameOverride = nginx-gateway-fabric, releaseName = chart, chart.name = nginx-gateway-fabric
result: chart-nginx-gateway-fabric
proxy: nginx-gateway-fabric-proxy-config
config: nginx-gateway-fabric-config

name = nginx-gateway-fabric, nameOverride = , releaseName = chart, chart.name = nginx-gateway-fabric
result: chart-nginx-gateway-fabric
proxy: nginx-gateway-fabric-proxy-config
config: nginx-gateway-fabric-config

Closes #2490

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

N/A

@tataruty tataruty requested a review from a team as a code owner June 18, 2025 14:47
@nginx-bot
Copy link

nginx-bot bot commented Jun 18, 2025

Hi @tataruty! Welcome to the project! 🎉

Thanks for opening this pull request!
Be sure to check out our Contributing Guidelines while you wait for someone on the team to review this.

@nginx-bot nginx-bot bot added the community label Jun 18, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request tests Pull requests that update tests helm-chart Relates to helm chart labels Jun 18, 2025
@tataruty tataruty mentioned this pull request Jun 18, 2025
Closed
6 tasks
@codecov
Copy link

codecov bot commented Jun 18, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.82%. Comparing base (bb219e2) to head (fd31a5b).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #3527      +/-   ##
==========================================
- Coverage   95.19%   86.82%   -8.38%     
==========================================
  Files           1      127     +126     
  Lines         229    15079   +14850     
  Branches       62       62              
==========================================
+ Hits          218    13092   +12874     
- Misses         11     1836    +1825     
- Partials        0      151     +151

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sjberman
Copy link
Collaborator

Since this is just a helm chart change, and less of a product feature, I'm going to remove the enhancement label from the PR. Labels get automatically added based on the branch name or contents of the diff.

These labels end up being used when we auto-generate release notes to organize the PRs into categories.

@sjberman sjberman removed enhancement New feature or request labels Jun 18, 2025
sjberman
sjberman approved these changes Jun 18, 2025
View reviewed changes
Copy link
Collaborator

@sjberman sjberman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice test cases!

@github-actions github-actions bot added the enhancement New feature or request label Jun 18, 2025
@tataruty tataruty closed this Jun 18, 2025
@tataruty tataruty deleted the feature/add_name_to_helm_chart branch June 18, 2025 16:04
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in NGINX Gateway Fabric Jun 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sjberman sjberman sjberman approved these changes

Assignees

No one assigned

Labels

community documentation Improvements or additions to documentation enhancement New feature or request helm-chart Relates to helm chart tests Pull requests that update tests

Projects

NGINX Gateway Fabric
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add nginxGateway.name in helm chart

2 participants

@tataruty @sjberman